feat: add scroll container prop by DaffPunks · Pull Request #1166 · gravity-ui/markdown-editor

DaffPunks · 2026-06-30T18:33:49Z

If editor placed in scrollable container, this happens:

2026-06-30.21.53.49.mov

Because isStickyActive depends on window.addEventListener('scroll', ...). When window is not scrollable, toolbar don't add class: g-md-editor-sticky_sticky-active

Now, with scrollContainerRef if behaves like this:
https://preview.gravity-ui.com/md-editor/1166/?path=/story/experiments-sticky-toolbar-in-scroll-container--story

Summary by Sourcery

Add support for sticky toolbars that work inside a custom scroll container instead of only the browser window.

New Features:

Introduce an optional scrollContainerRef prop across editor and toolbar views to enable sticky behavior within a specified scrollable container.
Add a demo Storybook story showcasing a markdown editor with a sticky toolbar inside a scrollable container.

Enhancements:

Extend the useSticky hook to listen to scroll-related events on a provided container element and compute stickiness relative to that container.
Adjust MarkdownEditorView styling to handle layouts when a custom scroll container is used via a dedicated modifier class.

sourcery-ai · 2026-06-30T18:33:56Z

Reviewer's Guide

Add support for sticky toolbars inside a custom scroll container by extending useSticky to accept a scrollContainerRef, wiring the prop through editor view/toolbar components, and documenting the behavior with a new Storybook experiment.

File-Level Changes

Change	Details	Files
Extend sticky behavior hook to work with either the window or a provided scroll container element.	Introduce CONTAINER_EVENTS set and a getTarget helper to route scroll-related events to either window or the scroll container. Add optional scrollContainerRef parameter to useSticky and compute naturalTopFromContainer based on element and container bounding rectangles. Adjust stickyActive calculation to use scrollContainer.scrollTop when a container is provided, while preserving existing window-based logic as fallback. Update event listener registration and cleanup to use getTarget instead of hard-coded window.	`packages/editor/src/react-utils/useSticky.ts`
Propagate scrollContainerRef through editor view, toolbar, and settings components so sticky toolbars can track container scrolling.	Add optional scrollContainerRef to ViewProps, ToolbarViewProps, MarkupEditorViewProps, and WysiwygEditorViewProps type definitions. Pass scrollContainerRef from MarkdownEditorView through EditorWrapper, toolbar render paths, Settings, and ToolbarView components. Use scrollContainerRef when calling useSticky in Settings and ToolbarView so sticky state is based on container scroll. Add withScrollContainer modifier class when scrollContainerRef is present and define corresponding SCSS rule to relax height constraints.	`packages/editor/src/bundle/MarkdownEditorView.tsx` `packages/editor/src/bundle/ToolbarView.tsx` `packages/editor/src/bundle/MarkupEditorView.tsx` `packages/editor/src/bundle/WysiwygEditorView.tsx` `packages/editor/src/bundle/MarkdownEditorView.scss`
Add a Storybook demo showcasing sticky toolbar behavior inside a scrollable container.	Create EditorWithStickyInContainer component that wraps MarkdownEditorView in a fixed-height scrollable div and passes scrollContainerRef to the editor. Initialize a markdown editor instance with rich initial content to ensure scrolling within the container. Register a new Storybook story under 'Experiments / Sticky Toolbar in Scroll Container' using EditorWithStickyInContainer.	`demo/src/stories/experiments/sticky-toolbar/Editor.tsx` `demo/src/stories/experiments/sticky-toolbar/StickyToolbar.stories.tsx`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey - I've found 1 issue, and left some high level feedback:

The naturalTopFromContainer value is computed only once on mount, so if the layout or container padding changes after initial render the sticky threshold will be off; consider recalculating it inside observe() or when relevant reflow events fire.
The scrollContainer reference and getTarget are captured once in useEffectOnce, so if scrollContainerRef.current ever changes (e.g. different container or ref reassignment) listeners will still be attached to the old target; if that’s a valid use case, you may want to re-run the effect when the ref changes.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The `naturalTopFromContainer` value is computed only once on mount, so if the layout or container padding changes after initial render the sticky threshold will be off; consider recalculating it inside `observe()` or when relevant reflow events fire.
- The `scrollContainer` reference and `getTarget` are captured once in `useEffectOnce`, so if `scrollContainerRef.current` ever changes (e.g. different container or ref reassignment) listeners will still be attached to the old target; if that’s a valid use case, you may want to re-run the effect when the ref changes.

## Individual Comments

### Comment 1
<location path="packages/editor/src/react-utils/useSticky.ts" line_range="60" />
<code_context>
-            const refPageOffset = elemRef.current.getBoundingClientRect().top;
-            const stickyOffset = parseInt(getComputedStyle(elemRef.current).top, 10);
-            const stickyActive = refPageOffset <= stickyOffset;
+            const stickyOffset = parseInt(getComputedStyle(elemRef.current).top);
+
+            let stickyActive: boolean;
</code_context>
<issue_to_address>
**nitpick:** Explicitly pass a radix to `parseInt` for clarity and robustness

The previous code used `parseInt(..., 10)`; omitting the radix now relies on environment defaults and may conflict with lint rules. Restoring `10` keeps the behavior explicit and consistent across environments.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

gravity-ui · 2026-06-30T18:35:53Z

gravity-ui · 2026-06-30T18:39:10Z

d3m1d0v · 2026-07-01T14:21:13Z

+        const naturalTopFromContainer =
+            scrollContainer && elemRef.current
+                ? elemRef.current.getBoundingClientRect().top -
+                  scrollContainer.getBoundingClientRect().top -
+                  scrollContainer.clientTop
+                : null;


I think it's better to move this to the observe()

d3m1d0v · 2026-07-01T14:24:49Z

Please, move this story to demo/src/stories/examples

DaffPunks requested review from d3m1d0v and makhnatkin as code owners June 30, 2026 18:33

sourcery-ai Bot reviewed Jun 30, 2026

View reviewed changes

Comment thread packages/editor/src/react-utils/useSticky.ts Outdated

DaffPunks force-pushed the scroll-container-prop branch from def845c to 0cea852 Compare June 30, 2026 18:50

feat: add scroll container prop

03e6fe7

DaffPunks force-pushed the scroll-container-prop branch from 0cea852 to 03e6fe7 Compare June 30, 2026 18:57

d3m1d0v reviewed Jul 1, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add scroll container prop#1166

feat: add scroll container prop#1166
DaffPunks wants to merge 1 commit into
mainfrom
scroll-container-prop

DaffPunks commented Jun 30, 2026 •

edited

Loading

Uh oh!

sourcery-ai Bot commented Jun 30, 2026 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Uh oh!

Uh oh!

gravity-ui Bot commented Jun 30, 2026

Uh oh!

gravity-ui Bot commented Jun 30, 2026

Uh oh!

d3m1d0v Jul 1, 2026

Uh oh!

d3m1d0v Jul 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

DaffPunks commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai Bot commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gravity-ui Bot commented Jun 30, 2026

Uh oh!

gravity-ui Bot commented Jun 30, 2026

Uh oh!

d3m1d0v Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

d3m1d0v Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

DaffPunks commented Jun 30, 2026 •

edited

Loading

sourcery-ai Bot commented Jun 30, 2026 •

edited

Loading